home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / filehunt.zip / FILEHUNT.DOC < prev    next >
Text File  |  1992-02-07  |  8KB  |  188 lines
  1.  
  2.                                 FILEHUNT
  3.                                 ++++++++
  4.  
  5.                     version 3.05, by Michael Conley
  6.     released   2/07/92 from the Charlatan's Cabin BBS, Los Angeles, CA.
  7.  
  8. FILEHUNT is designed to be run as a live DOOR program on Wildcat! 3.x and 2.x 
  9. systems. It allows your users to search through the file listings from other
  10. BBSes, perhaps to locate a file they can't find on your system.  All you need
  11. to do is supply the listing files (you may be able to convince the other 
  12. sysops to upload them to you!) in a single-line text format.  In order to
  13. be compatible with FILEHUNT, the listing MUST have the filename beginning
  14. in the first column, and in all capital letters:
  15.  
  16. (sample line)
  17.  
  18. FILENAME.ZIP 244k 10/24/91 A really wonderful file that must be downloaded.
  19.  
  20. Any text after the name of the file is optional and may be in any format 
  21. as long as it's all on the same line, not more than 80 characters wide.
  22. My FLOP program can create such a file listing from the database, as can
  23. WCPRO! for version 3.x of Wildcat!, or F-PRO! for version 2.x of Wildcat!
  24.  
  25. SETTING UP A DOOR:
  26. ================== 
  27. The Wildcat! manual and other tutorials have done a fine job of explaining
  28. how to set up a door on your BBS.  Therefore I won't re-invent the wheel by
  29. going through all of the directory naming and batch file creating necessary
  30. to execute FILEHUNT.  
  31.  
  32. It's important to note that FILEHUNT will check the CURRENT directory (where
  33. your DOOR program is started) for either DOOR.SYS or CALLINFO.BBS.  Wildcat!
  34. version 3.x creates DOOR.SYS; earlier versions created CALLINFO.BBS.  On my
  35. system, I have a directory called DOORS, and my batch file copies DOOR.SYS
  36. into that directory, then change to that directory, then start FILEHUNT.
  37.  
  38. FILEHUNT also needs ENVIRONMENT VARIABLES:  These are used by Wildcat! 3.x
  39. and will be ignored by Wildcat! 2.x, but they MUST be present for each node
  40. of your Wildcat! system in order for FILEHUNT to function properly:
  41.  
  42. SET WCPORTID=2     < put these lines in your Wildcat! startup batch file and
  43. SET WCIRQID=3      <   check to be sure they are added to your environment.
  44.  
  45. If you have a non-standard port address, you'll need to provide an additional
  46. environment variable with the DECIMAL port address:
  47.  
  48. SET COMBASE=1016  << substitute your correct decimal port address here.
  49.  
  50. That will override the default address of the port number specified in 
  51. WCPORTID.   WCIRQID will still need to be set to the correct interrupt
  52. value.  FILEHUNT supports IRQs in the range 2-7.
  53.  
  54. A sample batch file for Wildcat! version 3.x would look something like this:
  55.  
  56. REM this is a sample batch file for FILEHUNT with Wildcat! 3.x
  57. REM this assumes you SHELL to your doors.  If you TERMINATE, you
  58. REM need to add a change-directory back to your startup directory
  59. REM and then run your startup batch file.
  60. ECHO OFF
  61. COPY C:\WC30\WCWORK\NODE%WCNODEID%\DOOR.SYS C:\WC30\DOORS\DOOR.SYS
  62. CD C:\WC30\DOORS
  63. FILEHUNT
  64. EXIT    
  65.  
  66. A sample batch file for Wildcat! version 2.x would look something like this:
  67.  
  68. REM this is a sample batch file for FILEHUNT with Wildcat! 2.x
  69. ECHO OFF
  70. CD \DOORS
  71. COPY C:\CAT\NODE1\CALLINFO.BBS C:\DOORS\CALLINFO.BBS
  72. FILEHUNT
  73. CD \CAT\NODE1
  74. NODE1.BAT
  75.  
  76. Note that FILEHUNT monitors time online and Carrier Detect, and will close
  77. and exit gracefully back to the node if the caller drops offline while in
  78. the door.
  79.  
  80. PREPARING FILEHUNT:
  81. ===================
  82. It's necessary to create a configuration file for FILEHUNT, named FILEHUNT.CFG,
  83. which must reside in the directory where you'll start FILEHUNT.  Here is a
  84. sample configuration file:
  85.  
  86. BBSNAME=The Charlatan's Cabin BBS
  87. CTSCHECK=YES
  88. LISTPATH=C:\WC30\DOORS
  89.  
  90. BOARDNAME=The Best BBS In The Land
  91. BOARDFILE=BEST.LST
  92. BOARDSYSOP=John Q. SysOp
  93. BOARDPHONE=(213) 555-5555
  94. BOARDCOLUMN=5
  95.  
  96. BOARDNAME=An Even Better BBS 
  97. BOARDFILE=BETTER.LST
  98. BOARDSYSOP=Oscar Wilde
  99. BOARDPHONE=(818) 555-5555
  100. BOARDCOLUMN=1
  101.  
  102. You may edit this file as desired, following these guidelines:
  103.  
  104.         BBSNAME= The name of YOUR BBS as you want it to appear in
  105.                  the program's displays.
  106.  
  107.         CTSCHECK= Indicate YES or NO ... do you want the program to
  108.                   check for Clear to Send?  Default is YES if this
  109.                   line isn't found.
  110.         
  111.         LISTPATH= The complete Path to your BBS file lists.
  112.  
  113. Next, you'll need to set up configuration information for each BBS file list
  114. you want to support in The File Hunter.  NOTE: You'll need to place ALL of the
  115. lists in the directory defined in LISTPATH.
  116.  
  117. A maximum of 18 BBS file lists may be included ... any beyond that will be
  118. ignored.
  119.  
  120. For each BBS list, create a block of entries consisting of these four lines:
  121.  
  122.  
  123.         BOARDNAME=  This is the name of the BBS which supplied the listing.
  124.                     Up to 40 characters may be used.  This will appear in 
  125.                     the various displays including the selection menu.
  126.  
  127.         BOARDFILE=  This is the exact filename of the BBS's file listing.
  128.                     (Remember to place this file in the directory defined
  129.                      up above in LISTPATH.)
  130.  
  131.         BOARDSYSOP= This is the name of the BBS's SysOp as you want it to
  132.                     appear when the search is taking place.
  133.  
  134.         BOARDPHONE= This is the phone number of the BBS.  I recommend that
  135.                     you include the area code, such as:  (213) 654-7337.
  136.                     This text will appear in the selection menu and also
  137.                     at the beginning of each search operation.
  138.  
  139.         BOARDCOLUMN= This is the column where the file name begins.  Nothing
  140.                      to the left of this column is displayed, and the search
  141.                      for any kind of match begins in this column.  
  142.  
  143. It's important to note that the block of options for each list must be filled
  144. out completely, or The File Hunter may produce unpredictable results!  Also, be sure
  145. to keep them in the order shown above.  Do NOT omit any lines or The File Hunter
  146. will reject the configuration file.        
  147.  
  148. ------------------------------------------------------------------
  149. PROBLEMS, SUGGESTIONS:
  150.  
  151. This program is public domain.  I don't seek or accept any donations for 
  152. this  or any of my other Wildcat! utility programs, including TODAYBBS, 
  153. FLOP, MSTAT, USTAT, and others.
  154.  
  155. I welcome suggestions, and will try to help (no guarantees) if there are
  156. problems.
  157.  
  158. You may contact me at The Charlatan's Cabin BBS  (213) 654-7337.  Mention
  159. your Wildcat! registration number in the comment and you'll be upgraded to
  160. visiting sysop level without the usually required registration by mail.
  161.  
  162. You may also leave a message via CompuServe EMail. My CompuServe account 
  163. number is 70250,220.  I also regularly check the Mustang Software head-
  164. quarters BBS, especially the "3rd Party Utilities Help" conference.
  165.  
  166. Please, NO VOICE CALLS.  This isn't meant to be unfriendly, but with the 
  167. price of public domain software these days ... I just can't afford to be 
  168. "on call."  I WILL respond to your questions via my BBS or CompuServe,
  169. or via the Mustang Software registered SysOp BBS.
  170.  
  171. Version history:
  172.  
  173. 1.00     12/08/91       First release, compatible with Wildcat! 3.x as well
  174.                         as Wildcat! 2.x.
  175.  
  176. 1.01     12/08/91       Minor bug fix to handle backspacing from remote when
  177.                         input line is empty.
  178.  
  179. 3.03     01/19/92       Revised version number to correspond with other doors.
  180.                         Enabled total of 18 lists in menu.  Fixed local display
  181.                         erase line function if no remote online.
  182.  
  183. 3.04     01/19/92       Fixed CTS checking bug.
  184.  
  185. 3.05     02/07/92       Recompiled with QBSerial 2.1 by Jeff Sumberg.  More
  186.                         reliable on a multi-tasking machine.
  187.  
  188.